<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>MDC xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/slf4j/MDC.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_javadoccomment"> * Copyright (c) 2004-2011 QOS.ch</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_javadoccomment"> * All rights reserved.</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_javadoccomment"> * Permission is hereby granted, free  of charge, to any person obtaining</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_javadoccomment"> * a  copy  of this  software  and  associated  documentation files  (the</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_javadoccomment"> * "Software"), to  deal in  the Software without  restriction, including</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_javadoccomment"> * without limitation  the rights to  use, copy, modify,  merge, publish,</em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_javadoccomment"> * distribute,  sublicense, and/or sell  copies of  the Software,  and to</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_javadoccomment"> * permit persons to whom the Software  is furnished to do so, subject to</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_javadoccomment"> * the following conditions:</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_javadoccomment"> * The  above  copyright  notice  and  this permission  notice  shall  be</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_javadoccomment"> * included in all copies or substantial portions of the Software.</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_javadoccomment"> * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  <em class="jxr_javadoccomment"> * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF</em>
<a class="jxr_linenumber" name="18" href="#18">18</a>  <em class="jxr_javadoccomment"> * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND</em>
<a class="jxr_linenumber" name="19" href="#19">19</a>  <em class="jxr_javadoccomment"> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE</em>
<a class="jxr_linenumber" name="20" href="#20">20</a>  <em class="jxr_javadoccomment"> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION</em>
<a class="jxr_linenumber" name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION</em>
<a class="jxr_linenumber" name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</em>
<a class="jxr_linenumber" name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <strong class="jxr_keyword">package</strong> org.slf4j;
<a class="jxr_linenumber" name="26" href="#26">26</a>  
<a class="jxr_linenumber" name="27" href="#27">27</a>  <strong class="jxr_keyword">import</strong> java.util.Map;
<a class="jxr_linenumber" name="28" href="#28">28</a>  
<a class="jxr_linenumber" name="29" href="#29">29</a>  <strong class="jxr_keyword">import</strong> org.slf4j.helpers.NOPMDCAdapter;
<a class="jxr_linenumber" name="30" href="#30">30</a>  <strong class="jxr_keyword">import</strong> org.slf4j.helpers.BasicMDCAdapter;
<a class="jxr_linenumber" name="31" href="#31">31</a>  <strong class="jxr_keyword">import</strong> org.slf4j.helpers.Util;
<a class="jxr_linenumber" name="32" href="#32">32</a>  <strong class="jxr_keyword">import</strong> org.slf4j.impl.StaticMDCBinder;
<a class="jxr_linenumber" name="33" href="#33">33</a>  <strong class="jxr_keyword">import</strong> org.slf4j.spi.MDCAdapter;
<a class="jxr_linenumber" name="34" href="#34">34</a>  
<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * This class hides and serves as a substitute for the underlying logging</em>
<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * system's MDC implementation.</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * If the underlying logging system offers MDC functionality, then SLF4J's MDC,</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * i.e. this class, will delegate to the underlying system's MDC. Note that at</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * this time, only two logging systems, namely log4j and logback, offer MDC</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * functionality. For java.util.logging which does not support MDC,</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * {@link BasicMDCAdapter} will be used. For other systems, i.e slf4j-simple</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * and slf4j-nop, {@link NOPMDCAdapter} will be used.</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * Thus, as a SLF4J user, you can take advantage of MDC in the presence of log4j,</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * logback, or java.util.logging, but without forcing these systems as</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * dependencies upon your users.</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> * For more information on MDC please see the &lt;a</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> * href="<a href="http://logback.qos.ch/manual/mdc.html" target="alexandria_uri">http://logback.qos.ch/manual/mdc.html</a>"&gt;chapter on MDC&lt;/a&gt; in the</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> * logback manual.</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> * Please note that all methods in this class are static.</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> * @author Ceki G&amp;uuml;lc&amp;uuml;</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> * @since 1.4.1</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../org/slf4j/MDC.html">MDC</a> {
<a class="jxr_linenumber" name="64" href="#64">64</a>  
<a class="jxr_linenumber" name="65" href="#65">65</a>    <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NULL_MDCA_URL = <span class="jxr_string">"http://www.slf4j.org/codes.html#null_MDCA"</span>;
<a class="jxr_linenumber" name="66" href="#66">66</a>    <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String NO_STATIC_MDC_BINDER_URL = <span class="jxr_string">"http://www.slf4j.org/codes.html#no_static_mdc_binder"</span>;
<a class="jxr_linenumber" name="67" href="#67">67</a>    <strong class="jxr_keyword">static</strong> <a href="../../org/slf4j/spi/MDCAdapter.html">MDCAdapter</a> mdcAdapter;
<a class="jxr_linenumber" name="68" href="#68">68</a>  
<a class="jxr_linenumber" name="69" href="#69">69</a>    <strong class="jxr_keyword">private</strong> <a href="../../org/slf4j/MDC.html">MDC</a>() {
<a class="jxr_linenumber" name="70" href="#70">70</a>    }
<a class="jxr_linenumber" name="71" href="#71">71</a>  
<a class="jxr_linenumber" name="72" href="#72">72</a>    <strong class="jxr_keyword">static</strong> {
<a class="jxr_linenumber" name="73" href="#73">73</a>      <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="74" href="#74">74</a>        mdcAdapter = StaticMDCBinder.SINGLETON.getMDCA();
<a class="jxr_linenumber" name="75" href="#75">75</a>      } <strong class="jxr_keyword">catch</strong> (NoClassDefFoundError ncde) {
<a class="jxr_linenumber" name="76" href="#76">76</a>        mdcAdapter = <strong class="jxr_keyword">new</strong> <a href="../../org/slf4j/helpers/NOPMDCAdapter.html">NOPMDCAdapter</a>();
<a class="jxr_linenumber" name="77" href="#77">77</a>        String msg = ncde.getMessage();
<a class="jxr_linenumber" name="78" href="#78">78</a>        <strong class="jxr_keyword">if</strong> (msg != <strong class="jxr_keyword">null</strong> &amp;&amp; msg.indexOf(<span class="jxr_string">"StaticMDCBinder"</span>) != -1) {
<a class="jxr_linenumber" name="79" href="#79">79</a>          Util.report(<span class="jxr_string">"Failed to load class \&quot;org.slf4j.impl.StaticMDCBinder\&quot;."</span>);
<a class="jxr_linenumber" name="80" href="#80">80</a>          Util.report(<span class="jxr_string">"Defaulting to no-operation MDCAdapter implementation."</span>);
<a class="jxr_linenumber" name="81" href="#81">81</a>          <a href="../../org/slf4j/helpers/Util.html">Util</a>
<a class="jxr_linenumber" name="82" href="#82">82</a>              .report(<span class="jxr_string">"See "</span> + NO_STATIC_MDC_BINDER_URL + <span class="jxr_string">" for further details."</span>);
<a class="jxr_linenumber" name="83" href="#83">83</a>        } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="84" href="#84">84</a>          <strong class="jxr_keyword">throw</strong> ncde;
<a class="jxr_linenumber" name="85" href="#85">85</a>        }
<a class="jxr_linenumber" name="86" href="#86">86</a>      } <strong class="jxr_keyword">catch</strong> (Exception e) {
<a class="jxr_linenumber" name="87" href="#87">87</a>        <em class="jxr_comment">// we should never get here</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>        Util.report(<span class="jxr_string">"MDC binding unsuccessful."</span>, e);
<a class="jxr_linenumber" name="89" href="#89">89</a>      }
<a class="jxr_linenumber" name="90" href="#90">90</a>    }
<a class="jxr_linenumber" name="91" href="#91">91</a>  
<a class="jxr_linenumber" name="92" href="#92">92</a>    <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment">   * Put a diagnostic context value (the &lt;code&gt;val&lt;/code&gt; parameter) as identified with the</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment">   * &lt;code&gt;key&lt;/code&gt; parameter into the current thread's diagnostic context map. The</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment">   * &lt;code&gt;key&lt;/code&gt; parameter cannot be null. The &lt;code&gt;val&lt;/code&gt; parameter</em>
<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment">   * can be null only if the underlying implementation supports it.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment">   * &lt;p&gt;</em>
<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment">   * This method delegates all work to the MDC of the underlying logging system.</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment">   *</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment">   * @param key non-null key </em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment">   * @param val value to put in the map</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">   * @throws IllegalArgumentException</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment">   *           in case the "key" parameter is null</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="107" href="#107">107</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> put(String key, String val)
<a class="jxr_linenumber" name="108" href="#108">108</a>       <strong class="jxr_keyword">throws</strong> IllegalArgumentException {
<a class="jxr_linenumber" name="109" href="#109">109</a>     <strong class="jxr_keyword">if</strong> (key == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="110" href="#110">110</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"key parameter cannot be null"</span>);
<a class="jxr_linenumber" name="111" href="#111">111</a>     }
<a class="jxr_linenumber" name="112" href="#112">112</a>     <strong class="jxr_keyword">if</strong> (mdcAdapter == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="113" href="#113">113</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"MDCAdapter cannot be null. See also "</span>
<a class="jxr_linenumber" name="114" href="#114">114</a>           + NULL_MDCA_URL);
<a class="jxr_linenumber" name="115" href="#115">115</a>     }
<a class="jxr_linenumber" name="116" href="#116">116</a>     mdcAdapter.put(key, val);
<a class="jxr_linenumber" name="117" href="#117">117</a>   }
<a class="jxr_linenumber" name="118" href="#118">118</a> 
<a class="jxr_linenumber" name="119" href="#119">119</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment">   * Get the diagnostic context identified by the &lt;code&gt;key&lt;/code&gt; parameter. The</em>
<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment">   * &lt;code&gt;key&lt;/code&gt; parameter cannot be null.</em>
<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment">   * &lt;p&gt;</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment">   * This method delegates all work to the MDC of the underlying logging system.</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment">   *</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment">   * @param key  </em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment">   * @return the string value identified by the &lt;code&gt;key&lt;/code&gt; parameter.</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">   * @throws IllegalArgumentException</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment">   *           in case the "key" parameter is null</em>
<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="131" href="#131">131</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> String get(String key) <strong class="jxr_keyword">throws</strong> IllegalArgumentException {
<a class="jxr_linenumber" name="132" href="#132">132</a>     <strong class="jxr_keyword">if</strong> (key == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="133" href="#133">133</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"key parameter cannot be null"</span>);
<a class="jxr_linenumber" name="134" href="#134">134</a>     }
<a class="jxr_linenumber" name="135" href="#135">135</a> 
<a class="jxr_linenumber" name="136" href="#136">136</a>     <strong class="jxr_keyword">if</strong> (mdcAdapter == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="137" href="#137">137</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"MDCAdapter cannot be null. See also "</span>
<a class="jxr_linenumber" name="138" href="#138">138</a>           + NULL_MDCA_URL);
<a class="jxr_linenumber" name="139" href="#139">139</a>     }
<a class="jxr_linenumber" name="140" href="#140">140</a>     <strong class="jxr_keyword">return</strong> mdcAdapter.get(key);
<a class="jxr_linenumber" name="141" href="#141">141</a>   }
<a class="jxr_linenumber" name="142" href="#142">142</a> 
<a class="jxr_linenumber" name="143" href="#143">143</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment">   * Remove the diagnostic context identified by the &lt;code&gt;key&lt;/code&gt; parameter using</em>
<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment">   * the underlying system's MDC implementation. The &lt;code&gt;key&lt;/code&gt; parameter</em>
<a class="jxr_linenumber" name="146" href="#146">146</a> <em class="jxr_javadoccomment">   * cannot be null. This method does nothing if there is no previous value</em>
<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment">   * associated with &lt;code&gt;key&lt;/code&gt;.</em>
<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment">   *</em>
<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment">   * @param key  </em>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment">   * @throws IllegalArgumentException</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment">   *           in case the "key" parameter is null</em>
<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="153" href="#153">153</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> remove(String key) <strong class="jxr_keyword">throws</strong> IllegalArgumentException {
<a class="jxr_linenumber" name="154" href="#154">154</a>     <strong class="jxr_keyword">if</strong> (key == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="155" href="#155">155</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"key parameter cannot be null"</span>);
<a class="jxr_linenumber" name="156" href="#156">156</a>     }
<a class="jxr_linenumber" name="157" href="#157">157</a> 
<a class="jxr_linenumber" name="158" href="#158">158</a>     <strong class="jxr_keyword">if</strong> (mdcAdapter == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="159" href="#159">159</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"MDCAdapter cannot be null. See also "</span>
<a class="jxr_linenumber" name="160" href="#160">160</a>           + NULL_MDCA_URL);
<a class="jxr_linenumber" name="161" href="#161">161</a>     }
<a class="jxr_linenumber" name="162" href="#162">162</a>     mdcAdapter.remove(key);
<a class="jxr_linenumber" name="163" href="#163">163</a>   }
<a class="jxr_linenumber" name="164" href="#164">164</a> 
<a class="jxr_linenumber" name="165" href="#165">165</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment">   * Clear all entries in the MDC of the underlying implementation.</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="168" href="#168">168</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> clear() {
<a class="jxr_linenumber" name="169" href="#169">169</a>     <strong class="jxr_keyword">if</strong> (mdcAdapter == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="170" href="#170">170</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"MDCAdapter cannot be null. See also "</span>
<a class="jxr_linenumber" name="171" href="#171">171</a>           + NULL_MDCA_URL);
<a class="jxr_linenumber" name="172" href="#172">172</a>     }
<a class="jxr_linenumber" name="173" href="#173">173</a>     mdcAdapter.clear();
<a class="jxr_linenumber" name="174" href="#174">174</a>   }
<a class="jxr_linenumber" name="175" href="#175">175</a> 
<a class="jxr_linenumber" name="176" href="#176">176</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="177" href="#177">177</a> <em class="jxr_javadoccomment">   * Return a copy of the current thread's context map, with keys and values of</em>
<a class="jxr_linenumber" name="178" href="#178">178</a> <em class="jxr_javadoccomment">   * type String. Returned value may be null.</em>
<a class="jxr_linenumber" name="179" href="#179">179</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_javadoccomment">   * @return A copy of the current thread's context map. May be null.</em>
<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment">   * @since 1.5.1</em>
<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="183" href="#183">183</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> Map getCopyOfContextMap() {
<a class="jxr_linenumber" name="184" href="#184">184</a>     <strong class="jxr_keyword">if</strong> (mdcAdapter == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="185" href="#185">185</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"MDCAdapter cannot be null. See also "</span>
<a class="jxr_linenumber" name="186" href="#186">186</a>           + NULL_MDCA_URL);
<a class="jxr_linenumber" name="187" href="#187">187</a>     }
<a class="jxr_linenumber" name="188" href="#188">188</a>     <strong class="jxr_keyword">return</strong> mdcAdapter.getCopyOfContextMap();
<a class="jxr_linenumber" name="189" href="#189">189</a>   }
<a class="jxr_linenumber" name="190" href="#190">190</a> 
<a class="jxr_linenumber" name="191" href="#191">191</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment">   * Set the current thread's context map by first clearing any existing map and</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment">   * then copying the map passed as parameter. The context map passed as</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment">   * parameter must only contain keys and values of type String.</em>
<a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="196" href="#196">196</a> <em class="jxr_javadoccomment">   * @param contextMap</em>
<a class="jxr_linenumber" name="197" href="#197">197</a> <em class="jxr_javadoccomment">   *          must contain only keys and values of type String</em>
<a class="jxr_linenumber" name="198" href="#198">198</a> <em class="jxr_javadoccomment">   * @since 1.5.1</em>
<a class="jxr_linenumber" name="199" href="#199">199</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="200" href="#200">200</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> setContextMap(Map contextMap) {
<a class="jxr_linenumber" name="201" href="#201">201</a>     <strong class="jxr_keyword">if</strong> (mdcAdapter == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="202" href="#202">202</a>       <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"MDCAdapter cannot be null. See also "</span>
<a class="jxr_linenumber" name="203" href="#203">203</a>           + NULL_MDCA_URL);
<a class="jxr_linenumber" name="204" href="#204">204</a>     }
<a class="jxr_linenumber" name="205" href="#205">205</a>     mdcAdapter.setContextMap(contextMap);
<a class="jxr_linenumber" name="206" href="#206">206</a>   }
<a class="jxr_linenumber" name="207" href="#207">207</a> 
<a class="jxr_linenumber" name="208" href="#208">208</a>   <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="209" href="#209">209</a> <em class="jxr_javadoccomment">   * Returns the MDCAdapter instance currently in use.</em>
<a class="jxr_linenumber" name="210" href="#210">210</a> <em class="jxr_javadoccomment">   * </em>
<a class="jxr_linenumber" name="211" href="#211">211</a> <em class="jxr_javadoccomment">   * @return the MDcAdapter instance currently in use.</em>
<a class="jxr_linenumber" name="212" href="#212">212</a> <em class="jxr_javadoccomment">   * @since 1.4.2</em>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment">   */</em>
<a class="jxr_linenumber" name="214" href="#214">214</a>   <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../org/slf4j/spi/MDCAdapter.html">MDCAdapter</a> getMDCAdapter() {
<a class="jxr_linenumber" name="215" href="#215">215</a>     <strong class="jxr_keyword">return</strong> mdcAdapter;
<a class="jxr_linenumber" name="216" href="#216">216</a>   }
<a class="jxr_linenumber" name="217" href="#217">217</a> 
<a class="jxr_linenumber" name="218" href="#218">218</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

